Skip to main content
POST
Create an audience segment

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowPassword
Token URL
auth/jwt/login

Body

application/json

Represents a audience segment entity.

management_type
enum<string>
required

The management type of the audience segment

Available options:
selfmanaged,
systemmanaged
name
string
required

Name of the audience segment

owner_id
string<uuid>
required

Owner ID of the audience segment

approximated_size
integer | null

Approximated size of the audience segment.

created_at
string<date-time> | null

The date and time the entity was created.

deprecated_properties
Deprecated Properties · object

Deprecated properties for the audience segment.

description
string | null

Description of the audience segment

properties
Properties · object

Properties for the audience segment.

updated_at
string<date-time> | null

The date and time the entity was last updated.

Response

Successful Response

Represents a audience segment entity.

id
string<uuid>
required
management_type
enum<string>
required

The management type of the audience segment

Available options:
selfmanaged,
systemmanaged
name
string
required

Name of the audience segment

no
integer
required
owner_id
string<uuid>
required

Owner ID of the audience segment

approximated_size
integer | null

Approximated size of the audience segment.

created_at
string<date-time> | null

The date and time the entity was created.

deprecated_properties
Deprecated Properties · object

Deprecated properties for the audience segment.

description
string | null

Description of the audience segment

properties
Properties · object

Properties for the audience segment.

updated_at
string<date-time> | null

The date and time the entity was last updated.